Вспомогательные запросы

Утилитарные endpoint’ы, не привязанные к конкретному ресурсу: расчёт стоимости и набор autocomplete-поисков по справочникам (адрес, банк, город, компания).

Калькулятор

Расчёт стоимости товара

Метод: POST
URL: https://api.gigma.ru/api/orders/calculator
Авторизация: Bearer token
Headers: Accept: application/json; Content-Type: application/json

Считает итоговую цену с учётом наценки и скидки. Не сохраняет ничего в базе.

Параметры запроса (тело)

price — себестоимость товара (обязательно)
markup — наценка в процентах (обязательно, 0 если без наценки)
discount — скидка в процентах (обязательно, 0 если без скидки)

Пример запроса

{
    "price": 1000,
    "markup": 40,
    "discount": 1
}

Ответ

{
    "price": 1414
}

Описание полей ответа

price — итоговая стоимость с учётом наценки и скидки

Поиск адреса

Метод: POST
URL: https://api.gigma.ru/api/search_address
Авторизация: Bearer token
Headers: Accept: application/json; Content-Type: application/json

Подсказки адресов для autocomplete (как DaData). Возвращает список вариантов, сопоставимых с введённой строкой.

Параметры запроса (тело)

query — поисковая строка

Пример запроса

{
    "query": "Новогодняя 20"
}

Ответ

{
    "addresses": [
        { "name": "г. Новосибирск, ул. Новогодняя, д. 20", "value": "630073, г. Новосибирск, Новогодняя ул., д. 20" },
        { "name": "г. Новосибирск, ул. Новогодняя, д. 20/1", "value": "630073, г. Новосибирск, Новогодняя ул., д. 20/1" }
    ],
    "addressesCount": 2
}

Описание полей ответа

addresses[] — варианты: name (короткое представление), value (полный адрес)
addressesCount — количество результатов

Поиск банка

Метод: POST
URL: https://api.gigma.ru/api/search_bank
Авторизация: Bearer token
Headers: Accept: application/json; Content-Type: application/json

Подсказки банковских реквизитов по БИК или названию. Возвращает шаблонные IBankRequisite для авто-заполнения формы.

Параметры запроса (тело)

query — поисковая строка (БИК или название банка)

Пример запроса

{
    "query": "Сбер"
}

Ответ

{
    "banks": [
        {
            "name": "ПАО Сбербанк",
            "bik": "044525225",
            "kpp": "773601001",
            "payment_account": "",
            "address": "117997, г. Москва, ул. Вавилова, д. 19"
        }
    ],
    "banksCount": 1
}

Описание полей ответа

banks[] — варианты по форме IBankRequisite: name, bik, kpp, address, и т.п.
banksCount — количество результатов

Поиск компании

Метод: POST
URL: https://api.gigma.ru/api/search_company
Авторизация: Bearer token
Headers: Accept: application/json; Content-Type: application/json

Подсказки юрлиц по названию, ИНН или ОГРН. Используется в формах создания компании-контрагента и компании-бизнеса.

Параметры запроса (тело)

field — по какому полю искать: "name" | "inn" | "ogrn"
query — поисковая строка

Пример запроса

{
    "field": "inn",
    "query": "5403057658"
}

Ответ

{
    "companies": [
        {
            "name": "ООО "АЙТЕКО"",
            "inn": "5403057658",
            "orgn": "1185476049158",
            "legal_address": "630073, г. Новосибирск, Новогодняя ул., д. 20/1, кв. 26",
            "kpp": "540301001",
            "head": "Снегирёв Алексей Игоревич",
            "registration_date": "2020-04-02"
        }
    ],
    "companiesCount": 1
}

Описание полей ответа

companies[] — варианты компаний: name, inn, orgn (опц.), legal_address, kpp, head, registration_date (опц.)
companiesCount — количество результатов

Города

Список городов

Метод: GET
URL: https://api.gigma.ru/api/cities
Авторизация: Bearer token
Headers: Accept: application/json; Content-Type: application/json

Ответ

{
    "cities": [
        { "id": 1, "name": "Новосибирск", "avatar": "https://api.gigma.ru/storage/uploads/default.svg", "created_at": "2024-03-27T07:00:46.000000Z" },
        { "id": 2, "name": "Москва", "avatar": "https://api.gigma.ru/storage/uploads/default.svg", "created_at": "2024-03-27T07:00:46.000000Z" }
    ],
    "citiesCount": 2
}

Описание полей ответа

cities[] — массив: id, name, avatar, created_at
citiesCount — общее количество

Город по ID

Метод: GET
URL: https://api.gigma.ru/api/cities/{id}
Авторизация: Bearer token
Headers: Accept: application/json; Content-Type: application/json

Ответ

{
    "city": {
        "id": 1,
        "name": "Новосибирск",
        "avatar": "https://api.gigma.ru/storage/uploads/default.svg",
        "created_at": "2024-03-27T07:00:46.000000Z"
    }
}

Поиск номенклатуры

Метод: POST
URL: https://api.gigma.ru/api/search_nomenclature
Авторизация: Bearer token
Headers: Accept: application/json; Content-Type: application/json

Полнотекстовый поиск по номенклатуре через DaData. Возвращает список совпадений по названию.

Параметры запроса (тело)

query — поисковая строка

Пример запроса

{
    "query": "крем"
}

Ответ

При успешном действии возвращается HTTP код 200 с массивом совпадений.